home *** CD-ROM | disk | FTP | other *** search
/ Night Owl 9 / Night Owl CD-ROM (NOPV9) (Night Owl Publisher) (1993).ISO / 037a / pst11.zip / PST.DOC < prev    next >
Text File  |  1993-03-10  |  23KB  |  391 lines
  1.  
  2.  
  3.  
  4.                                      PST
  5.  
  6.                       A CHRONOLOGICAL PEDIGREE PROGRAM
  7.  
  8.  
  9. This program takes as input either a GEDCOM data base file (".GED") or a
  10. ROOTS III data base file (".EDB") and creates a Pedigree/Surname/Timeline
  11. chart for printing.  It is most useful for use with printers which have the
  12. capability of quite a few columns in width, such as the wide-carriage
  13. printers or those which can print in highly compressed type.  Typically one
  14. would want to be able to print at least 160 column charts, although, if one
  15. is willing to do a cut and paste operation on the pages one can get along
  16. with less capable printers.
  17.  
  18. The program creates a chart with time as the horizontal axis and a list of
  19. surnames as the vertical axis. It places the first letter of the first given
  20. name of an individual in the print column corresponding to the year of birth
  21. of the individual and the row corresponding to his or her  surname.  It
  22. operates in one of two modes, it will either create a chart with time
  23. decreasing from left to right (called "descending", the way one expects a
  24. pedigree chart to look) or the opposite, with the years increasing from left
  25. to right (called "ascending").  Both styles have their advantages in
  26. assisting data analysis.
  27.  
  28.                       ********* Installation *********
  29.  
  30. Installation is simple; just copy the file PST.EXE into any directory which
  31. appears in your PATH command list.  You may wish to copy the file PSTX.INS
  32. into the directory where you will be using the program so it will be handy
  33. for editing to establish your desired defaults (see Installation File,
  34. below).  NOTE: If you do not have DEVICE=ANSI.SYS in your CONFIG.SYS file,
  35. when PST finishes it may leave you with a blank screen.  ANSI.SYS only takes
  36. up about 4K of memory and you are encouraged to use it.  
  37.  
  38.                          ********* Running *********
  39.  
  40. To run the program just key in PST after the DOS prompt, and follow it by an
  41. (optional) list of parameters, each separated from any other by at least one
  42. space.
  43.  
  44.                         ******** Parameters ********
  45.  
  46. The program accepts several parameters to accommodate user's wishes.  These
  47. parameters may be entered by the user in one of three ways (or a combination
  48. of the three). The user may either provide the parameters in the command line
  49. that is used to call up the program, in an "installation" file in the
  50. "current" directory, or interactively as the program calls for them.  The
  51. user may provide some parameters in the installation file, some in the
  52. command line, and be interactively prompted for others.  If a given parameter
  53. is provided in both the installation file and the command line, the parameter
  54. in the command line will take precedence.  A parameter provided in either the
  55. installation file or the command line will not be interactively requested
  56. from the user at run time.  Some parameters may be omitted entirely; there
  57. are some default values built into the program; these parameters are never
  58. requested interactively.
  59.                   ******** Command Line Parameters ********
  60.  
  61.   PST followed by any of several parameters:
  62.  
  63.      m=<mode>  where mode may be either A (ascending) or D (descending); the
  64.           default value is descending; this is the way most pedigree charts
  65.           are presented.
  66.      s=<start year>  e.g. 1990 if using the descending mode to see years
  67.           earlier than 1990 or 1600 if using the ascending mode to see the
  68.           years later than 1600.
  69.      o=<output> where output is usually a file name for the chart or perhaps
  70.           a printer designation such as PRN
  71.      d=<database> which is the path\filename to the GEDCOM or ROOTS III file
  72.           (you must include the ".GED" or the ".EDB" so the program will
  73.           know which type of file to process).  A GEDCOM file must be in the
  74.           specs of PAF 2.1 or later.
  75.      f=<first Person Record number> identifying the root person for the
  76.           ancestor chart.  This is the record number in ROOTS III, the RIN
  77.           in PAF (if PAF created the GEDCOM), and so on. See below for a
  78.           special search feature if you don't know the number.
  79.      p=<printer max columns> - the maximum number of columns you want the
  80.           report to use.  Must be less than or equal to the number of print
  81.           positions you printer can handle.  The default value is 170, which
  82.           corresponds to an HP laser printer operating in "wide" mode using
  83.           the internal "line printer" font (16.67 cpi). Maximum value is
  84.           255.
  85.      y=<number of years per print column>; must be an integer - the default
  86.           value is 2.
  87.      a=<y or n> - indication whenter or not 11 columns on the left edge of
  88.           the paper will be devoted to the ahnentafel number of the first
  89.           person of that line who entered the family - always a woman except
  90.           for the first person.  The default is to not present this
  91.           information (y is for yes, n is for no).
  92.  
  93.   PST /? provides help on the screen like the above.
  94.  
  95.  
  96.                      ******** Installation file ********
  97.  
  98. You may create an installation file to establish your own personal defaults. 
  99. You might do this individually for each directory in which you plan to use
  100. PST. Call that file PST.INS.  Create it with a text editor, possibly by
  101. modifying the sample file provided.  An example follows:
  102.  
  103. Mode=A
  104. StartYear=1600
  105. OutFileName=junk.txt
  106. DatabaseName=C:\roots3\ancestor\ancestor.EDB
  107. FirstPerson=2
  108. YearsPerCol=2
  109. MaxCols=170
  110. Ahnentafel=Y
  111. Graphics=║╦╝╚═
  112. PrinterInit=^[&l0O^[(10U^[&l8D^[(s0p16.6h7v0s0T^O
  113.  
  114. Again, any/all of the entries may be omitted.  The items correspond to those
  115. for use in the command line, with the exception of two additional items,
  116. "Graphics" and PrinterInit.
  117.  
  118. The Graphics entry defines the graphic characters to be used to draw marriage
  119. lines on the charts.  They are entered in order after the equals sign as (1)
  120. the character to use to create the line going up, (2) the character to be
  121. used at the top of the line, (3) the character to be used at the bottom of
  122. the line when the mode is descending, (4) the character to be used at the
  123. bottom of the line when the mode is ascending, and (5) the character to be
  124. used for horizontal lines.  If you have trouble getting these characters to
  125. print and instead get a series of "foreign" alphabetics, it is likely that
  126. you have not set up your printer to recognize the correct symbol set.  For
  127. the graphics used as default and as illustrated above the symbol set should
  128. be PC8.  If you fail to get them to work on your printer, investigate your
  129. printer manual for either the initialization string elements to get the
  130. desired symbol set active or to discover the ASCII codes which will print the
  131. desired symbols. HP LJ IIP users may wish to use the printer front panel to
  132. select the PC8 symbol set (see the manual page 4-4). As a last resort, you
  133. may wish to use the "pipe" symbol "|" for the vertical line, and the minus
  134. sign for the horizontal line, ']' for the bottom line when descending, '['
  135. for the bottom line when ascending, and '+' for the top of the line
  136. (GRAPHICS=|+][-). Do NOT use any character which is likely to show up in the
  137. first names of people, do NOT use the same character for more than one
  138. graphic function and do NOT use the space character as a graphic.
  139.  
  140. The PrinterInit entry defines the string to be sent to the output at the
  141. beginning of the run, normally to establish the "wide" printing conditions. 
  142. Control characters are inserted by use of the preceding "^"; for example the
  143. escape character is "^[" and the control-s is entered as "^S".  Examples or
  144. strings for some printers follow; be VERY careful if copying these to your
  145. INS file to note the difference between 1 and l and 0 and O.  It would be
  146. best to copy them from this documentation file using a text editor.
  147.  
  148.      NEC Pinwriter P2200                           : ^[!^E              
  149.      Star NX10 (160 column compressed elite)       : ^[!^E
  150.                (160 column compressed elite bold)  : ^[!^U
  151.      HP LJ II  (170 column LinePrinter,PC8) 
  152.                Landscape, 8.5x11 paper, 170 Cols or
  153.                           8.5x14 paper, 225 Cols :
  154.                                ^[&l1O^[(10U^[&l8D^[(s0p16.6h7v0s0T^O
  155.                Portrait,  8.5x11 or 8.5x14 paper, 133 Cols :
  156.                                ^[&l0O^[(10U^[&l8D^[(s0p16.6h7v0s0T^O
  157.  
  158. An example of an installation file is included with the distribution as file
  159. PSTX.INS.  You may wish to rename it as PST.INS and then edit it to fit your
  160. circumstances.
  161.  
  162.             ********** Starting Person Search Feature ***********
  163.  
  164. If you don't know the identifying number of the individual you wish to use
  165. as the basis of the chart, leave the entry out of the installation file and
  166. the command line call, so you will be prompted for it when the program starts
  167. to run.   At that time, if you simply press enter, the screen will shift to
  168. a prompting mode where you will be asked to enter the first name, surname and
  169. year of birth of the individual.  You must enter in upper/lower case as it
  170. appears in the source file.  You may enter only fragments of the names (e.g.
  171. "ichar" in lieu of "Richard") if you wish, and you may omit any of the
  172. elements asked for.  After you have entered these items, the source data file
  173. is searched for possible matches; when one is found it is presented and you
  174. are given an opportunity to accept that entry or to continue or restart the
  175. search.  If you continue the search beyond the end of the file the process
  176. will recycle.  You may "escape" from the program operation at any time by
  177. pressing CONTROL-BREAK.
  178.  
  179.  
  180.                      ******** Program Sequence ********
  181.  
  182. The progress of the program is shown on the top line of the screen; the
  183. leftmost note on that line indicates the current process.  
  184.  
  185. First the installation file is read, and then the command line parameters,
  186. if any, are used to modify the settings.  If a required parameter is not set
  187. in either the PST file or the command line, then either the default value is
  188. used or the user is then interactively prompted for the value. After this the
  189. program collects all information it needs, then sends the chart, line by
  190. line, to the output device.  During the time that data is being extracted
  191. from the source file a "thermometer" on the second line indicates the
  192. progress.  Surnames that are being inserted in the chart are indicated on the
  193. third line as they are processed.
  194.  
  195.                         ******** The Output ********
  196.  
  197. The surnames shown on the left edge are those of the first person of that
  198. surname line to enter the family; invariably a woman except for the
  199. FirstPerson.  Variations in spelling of the surname in preceding generations
  200. are ignored.  All surname lines are listed even though some lines may not
  201. appear on the chart for the time period covered.
  202.  
  203. People are shown with their first names (only); the first letter of the first
  204. name appears in the appropriate column to represent the year of birth, or,
  205. if it is mnot in the data base, the year of christening.   People without
  206. either birth years or christening years represented in the data base will
  207. have their birth year estimated from the birth year of their in-line
  208. offspring; men are assumed to be born 32 years earlier and women 27 years
  209. earlier.  If a birth date is estimated in this way, the person's name will
  210. be preceded by an asterisk; this asterisk appears in the appropriate column
  211. to indicate the birth date estimated.  If there is no first name in the data,
  212. a '?' is printed in lieu of it.
  213.  
  214. Marriages are shown by a line from the wife over and up to the husband's
  215. surname line.  The vertical part of this line appears in the print position
  216. representing the year of the marriage.  In the descending mode this will
  217. frequently connect in the husbands surname line to the childs first name. 
  218. One can visualize that the graphics show the child's connection to the
  219. parents - on the same line for the father and down and over for the mother. 
  220. In the ascending mode, since the child's name extends toward later years,
  221. there is less confusion on this part.  If there is no marriage date available
  222. for a couple there is no graphic drawn connecting the wife to the husband's
  223. surname line.  In some cases in the ascending mode there is too little room
  224. for a graphic to be drawn due to length of names and proximity of surnames. 
  225. This should not be interpreted to mean there is no marriage date in the data
  226. base for them.  
  227.  
  228. There is an information file, PST3.TXT, left in the working directory.  This
  229. file contains information of use to you if you wish to avoid asterisks and
  230. missing vertical lines; it lists each individual for which an estimate of the
  231. birth date was made and those sets of parents for which no marriage year was
  232. found.
  233.  
  234.                         ******** Suggestions ********
  235.  
  236. The ideal way to run this program is to send the output to a file, NOT
  237. including a PrinterInit string, and use your word processor to look at the
  238. output and do additional formatting and printer setup before actually
  239. printing the result.  Assuming your word processor (and here I'm assuming
  240. Word Perfect because it's the one I'm familiar with) is set up properly for
  241. your printer, you should get excellent results with just a little
  242. experimenting.
  243.  
  244. If the entire pedigree won't fit on a single sheet horizontally - and few
  245. will - then you can run the program more than once, picking the StartYear for
  246. each subsequent run to match a year near the end of the previous run, then
  247. cut and tape the sheets together.  You could use the Ahnentafel feature on
  248. the first run and omit it from the others.  If the chart is several sheets
  249. wide you may wish to print an extra copy of the first column sheet so you can
  250. tape the surname list to the right hand side of the combined set.
  251.  
  252. If you have a printer with a scalable monospaced font (such as the HP-III
  253. with scalable Courier) you may find it useful to use a 5-point font; printing
  254. in landscape mode with 1/4 inch margins you may be able to get as many as 240
  255. print columns.  If you choose YearsPerColumn=3 that would get you a pedigree
  256. chart on one sheet spanning either 650 or 690 years, depending on whether the
  257. ahnentafel feature was on or off.
  258.  
  259. If you have WINDOWS with the true-type fonts and you select the new courier
  260. font when using WRITE, you will probably find that, when you open the text
  261. file written by PST, the conversion process will alter the symbols used. 
  262. MICROSOFT advises that an application note, number GC0651-3LD (for 3.5 inch
  263. disks) or GC-0651-5LD (for 5.25 inch disks) is comprised of a special font
  264. for WINDOWS and this font will preserve the line-draw symbols.  I was told
  265. that you may order this font by calling 800-426-9400, but when I tried it the
  266. person that answered didn't know what I was talking about, and suggested I
  267. call 206-637-7098.  Good luck.
  268.  
  269. If you do not have ANSI.SYS loaded, and are faced with a blank screen, just
  270. type MODE CO80 (in the blind; you won't see your typing echoed on the
  271. screen), hit enter and your screen should be back to normal.
  272.  
  273.  
  274.                        ******** Registration ********
  275.  
  276. This program is shareware.  That means that you are free to experiment with
  277. it and redistribute it as you wish; BUT if you feel the program has
  278. sufficient merit that you would like to use it as part of your processing
  279. capabilities, it would be appropriate for you to register with the author and
  280. pay the $5 fee the author requests for registration.  For this program this
  281. provides you with free updates of the program if such updates are created
  282. within a year of your registration; they will be mailed to you on 5.25 or 3.5
  283. inch disks, whichever you indicate you prefer at registration time.
  284.  
  285. The author's name and address:
  286.  
  287. Richard G. Cleaveland                    Please specify disk size
  288. 2373 N. Fillmore St.,                    desired when registering.
  289. Arlington, VA 22207-4953                   *** FEE $5 ***
  290.  
  291. The author may be contacted for information and for purposes of reporting
  292. apparent bugs through either direct mail at the address above or through
  293. Compuserve (72077,357) or Prodigy (PTGW13A).
  294.  
  295. A sample of the program output in the ascending mode and for a narrow printer
  296. is shown on the next page.  The repeated surnames (Fox, for example) appear
  297. because the data base has "Wife-Of <husband's name>" as the name of a woman
  298. with an unknown surname (in some cases; in others the surname "Unknown" was
  299. used).  This illustration will probably seem odd to most readers; the
  300. ascending mode is unconventional.
  301.   PST Beta 1   \ROOTS3\CLEAV.GED    Starting with Richard Cleaveland
  302.            1    1    1    1    1    1    1    1    1    1    1    1   
  303.            6    6    6    6    6    6    6    6    6    6    7    7   
  304.            0    1    2    3    4    5    6    7    8    9    0    1   
  305.            0    0    0    0    0    0    0    0    0    0    0    0   
  306. Cleaveland .    .    . Moses───────┬───────Josiah──────┬────Henry────┬
  307. Winn       .    .    .  Ann────────┘.    .    .    .   │.    .    .  │
  308. Bates      .    .    .    .    .    .    .  Mary───────┘.    .    .  │
  309. Fitch      s────┬─────James────────James──────────────┬─────Lucy─────┘
  310. Humphrey   .    │    .    .    .   │.    .    .    .  │ .    .    .   
  311. Thurgood   .    │    .    .    .   │.    .    .    .  │ .    .    .   
  312. Reeve      ─────┘    .    .    .   │.    .    .    .  │ .    .    .   
  313. Brock      .    .    .    .    .   │.    .    .    .  │ .    .    .   
  314. Whifield   enry─────┬─Abigail──────┘.    .    .    .  │ .    .    .   
  315. Atwood     .    .   │.    .    .    .    .    .    .  │ .    .    .   
  316. Manning    ─────────│.    .    .    .    .    .    .  │ .    .    .   
  317. Kirkener   .    .   │.    .    .    .    .    .    .  │ .    .    .   
  318. Sheafe     Dorothy──┘.    .    .    .    .    .    .  │ .    .    .   
  319. Harmon     .    .    .    .    .    .    .    .    .  │ .    .    .   
  320. Sheafe     ───────────────────────────────────────────│ .    .    .   
  321. Harmon     .    .    .    .    .    .    .    .    .  │ .    .    .   
  322. Bradford   am─────────┬William──────┬────Alice────────┘ .    .    .   
  323. Bradfuth   .    .    .│   .    .    │    .    .    .    .    .    .   
  324. Bradfuth   .    .    .│   .    .    │    .    .    .    .    .    .   
  325. Turvin     .    .    .│   .    .    │    .    .    .    .    .    .   
  326. Fox        ───────────│   .    .    │    .    .    .    .    .    .   
  327. Fox        .    .    .│   .    .    │    .    .    .    .    .    .   
  328. Hanson     ───────────│   .    .    │    .    .    .    .    .    .   
  329. Gresham    .    .    .│   .    .    │    .    .    .    .    .    .   
  330. Carpenter  ce─────────┘   .    .    │    .    .    .    .    .    .   
  331. Carpenter  .    .    .    .    .    │    .    .    .    .    .    .   
  332. Carpenter  .    .    .    .    .    │    .    .    .    .    .    .   
  333. Dillen     .    .    .    .    .    │    .    .    .    .    .    .   
  334. Richards   omas─────────Alice───────┘    .    .    .    .    .    .   
  335. Loring     Welthian  .    .    .    .    .    .    .    .    .    .   
  336. Brown      .    .    .    .    .    .    .    .    .    .    .    .   
  337. Warner     .    .    .    .    .    .    .    .    .    .    .    .   
  338. Hawkes     .    .    .    .    .    .    .    .    .    .    .    .   
  339. Littlefieldd──────┬──Anthony─────────Edmund─────────────Nathaniel─────
  340. Austin     nis────┘  .    .    .    .│   .    .    .    │    .    .   
  341. Page       .    .    .    .  Mary────┘   .    .    .    │    .    .   
  342. Mott       .    .    .    .    .    .    .    . Elizabeth    .    .   
  343. Thayer     .    .    .    .    .    .    .    .    .    .  *Deborah   
  344. Caswell    .    .    .    .    .    .    .    .    .    .    .    .   
  345. Brown      .    .    .    .    .    .    .    .    .    .    .    .   
  346. Thomas     .    .    .    .    .    .    .    .    .    .    .    .   
  347. Kirkland   .    .    .    .    .    .    .    .    .    .    .    .   
  348. Lang       .    .    .    .    .    .    .    .    .    .    .    .   
  349. Parcher    .    .    .    .    .    .    .    .    .    .    .    .   
  350. Pease      ───Robert───┬──John───────────────┬─Issac─────┬──────────Cu
  351. Unknown    .    .    . │  .    .    .    .   │.    .    .│   .    .   
  352. Unknown    .    Marie──┘  .    .    .    .   │.    .    .│   .    .   
  353. Cummings   .    .    .    .    . Ann─────────┘.    .    .│   .    .   
  354. Osborn     .    .    John────────John────────┬─Mindwell──┘   .    .   
  355. Oldage     .    .    . Ann───────┘  .    .   │.    .    .    .    .   
  356. Eggleston  .    .    . Begat─────┬─Abigail───┘.    .    .    .    .   
  357. Talcott    .    .    . Sarah─────┘  .    .    .    .    .    .    .   
  358. Pease      ───Robert───┬──John───────┬John───────┬John──────────────┬E
  359. Unknown    .    .    . │  .    .    .│   .    .  │ .    .    .    . │ 
  360. Unknown    .    Marie──┘  .    .    .│   .    .  │ .    .    .    . │ 
  361. Goodell    .  Robert─────Mary────────┘   .    .  │ .    .    .    . │ 
  362. Unknown    .   Catharine─┘.    .    .    .    .  │ .    .    .    . │ 
  363. Adams      .    .    .    .    .    . Margaret───┘ .    .    .    . │ 
  364. Spencer    .    .    .    .    .    .    .    .    .  Elizabeth─────┘ 
  365. Hill       .    .    .    .    .    .    .    .    .    .    . John───
  366. Craw       .    .    .    .    .    .    .    .    .    .    .    . De
  367. Laughlin   .    .    .    .    .    .    .    .    .    .    .    .   
  368. Adams      .    .    .    .    .    .    .    .    .    .    .    .   
  369. Streeter   .   Stephen─────────Stephen──────────Samuel──────Stephen───
  370. Adams      ────┬────Ursula─────┘    .    .    .    .    .    .    .   
  371. Unknown    .   │.    .    .    .    .    .    .    .    .    .    .   
  372. Stone      .   │.    .    .    .    .    .    .    .    .    .    .   
  373. Squire     ────┘.    .    .    .    .    .    .    .    .    .    .   
  374. Adams      .    .    .    .    .    .    .    .    .    .    . *Kather
  375. Hemingway  .    .    .    .    .    .    .    .    .    .    .    .   
  376. Alderman   .    .    .    .    .    .    .    .    .    .    .    .   
  377. Calligan   .    .    .    .    .    .    .    .    .    .    .    .   
  378. Helsom     .    .    .    .    .    .    .    .    .    .    .    .   
  379. Helsom     .    .    .    .    .    .    .    .    .    .    .    .   
  380. Slettevold .    .    .    .    .    .    .    .    .    .    .    .   
  381. Unknown    .    .    .    .    .    .    .    .    .    .    .    .   
  382. Beil       .    .    .    .    .    .    .    .    .    .    .    .   
  383. Seehofer   .    .    .    .    .    .    .    .    .    .    .    .   
  384.            1    1    1    1    1    1    1    1    1    1    1    1   
  385.            6    6    6    6    6    6    6    6    6    6    7    7   
  386.            0    1    2    3    4    5    6    7    8    9    0    1   
  387.            0    0    0    0    0    0    0    0    0    0    0    0   
  388.  
  389.  
  390. =======================[End of sample chart]===========================
  391.